home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _editors / editors / _zap / !Zap / Docs / Redraw < prev   
Text File  |  1994-04-23  |  38KB  |  869 lines
  1. *************************************************************************
  2. * >Redraw - Documentation for the ZapRedraw module v0.20        *
  3. *************************************************************************
  4.  
  5. Summary:
  6. --------
  7.  
  8. The module ZapRedraw provides the "ZapRedraw_" SWI's which are capable of
  9. drawing a rectangle of text characters on screen. It offers the following
  10. features:
  11.  
  12. * Redraw may be by direct screen access (henceforth DSA) where the
  13.   data is poked into the screen memory or by the standard VDU redraw.
  14.   
  15. * Full colour provided (with your own definable palette). Supports up to 32
  16.   bits per pixel in DSA mode and 24 bit colour in VDU mode.
  17.  
  18. * DSA redraw can handle any size of bitmap characters. Special optimised
  19.   code is provided by 8*8 pixel characters in 2,4,16 and 256 colour modes.
  20.   Also up to 65536 characters can be defined.
  21.   
  22. * VDU redraw mode can handle any font and font size.
  23.  
  24. * Support is provided for cursors.
  25.  
  26. * Many extra SWIs perform all the work of creating cached bitmaps, updating
  27.   them on a mode change etc. Swi's are also provided for creating palettes
  28.   and other functions related to the redraw.
  29.  
  30. * An example program is provided which can be used as a template.
  31.   
  32. Limitations:
  33.  
  34. * All characters are equally spaced. Proportional spacing is not supported.
  35.  
  36. Copyright:
  37. ----------
  38.  
  39. The ZapRedraw module is copyright Dominic Symes 1994. Please contact me if
  40. you wish to use it in a program other than Zap. See the Zap Copyright file
  41. for my address.
  42.  
  43. Definitions required for the SWI's
  44. ==================================
  45.  
  46. ZapRedraw chunk prefix: ZapRedraw
  47. ZapRedraw chunk number: &48480
  48.  
  49. All SWI numbers below are given as offsets from the chunk number.
  50.  
  51. 'DSA' means direct screen access mode (characters poked into the screen).
  52. 'VDU' means VDU mode (operating system called to draw characters).
  53.  
  54. Pixel co-ordinates are used wherever possible to prevent rounding errors when
  55. OS co-ordinates are not pixel aligned (these errors DO mess things up!).
  56. Pixel co-ordinates are from the top left of the screen with the y axis
  57. descending. By a 'pixel' I mean a hardware pixel (this differs from an OS
  58. pixel in double-pixel emulation modes - this only crops up in the RISC OS 2
  59. MODE 2 wimp!).
  60.  
  61. Zap redraw block:
  62. -----------------
  63.  
  64. For several SWI's, R1 points to a redraw block of the type described below.
  65. The SWI documentation will mention which data in the block is actually used
  66. by that SWI (so should be filled in). Each offset in the block is named with
  67. a name beginning 'r_'. The Basic program E-Library contains a procedure to
  68. set these variables up should you be using the Basic assembler. The contents
  69. of some offsets depends on which redraw mode is being used (VDU or DSA), this
  70. is indicated by 'VDU:' and 'DSA:'.
  71.  
  72. Offset    Name        Function
  73.  
  74. &00    r_flags        Flags word determining the type of redraw:
  75.             b0 Clear for DSA mode. Set for VDU redraw mode.
  76.             b1 Set for 'double height mode'. Only valid in DSA
  77.                mode. Draws each raster twice so actual character
  78.                height is 2*r_charh and spacing 2*r_linesp.
  79.             b2 Extension routine provided.
  80.                Only valid in DSA mode. See ZapRedraw_RedrawArea.
  81.             b3-31 Reserved - set to zero.
  82. &04    r_minx        Min x of redraw (pixels from lhs - inclusive)
  83. &08    r_miny        Min y of redraw (pixels from top - inclusive)
  84. &0C    r_maxx        Max x of redraw (pixels form lhs - exclusive)
  85. &10    r_maxy        Max y of redraw (pixels from top - exclusive)
  86. &14    r_screen    DSA: Address of screen to write to or 0 to read the
  87.                  current screen address.
  88.             VDU: ignored
  89. &18    r_bpl        DSA: Bytes per raster line of the screen
  90.             VDU: ignored
  91. &1C    r_bpp        Log base 2 of number of bits per pixel
  92.             (ie 0=2 cols 1=4 cols 2=16 cols 3=256 cols
  93.             4=65536 cols 5=2^32 cols).
  94. &20    r_charw        Width of a character in pixels
  95. &24    r_charh        Height of a character in pixels
  96. &28    r_caddr        DSA: Address of character cache (format below)
  97.             VDU: Pointer to font name or 0 for system font
  98. &2C    r_cbpl        DSA: Number of bytes per cached character line.
  99.             VDU: x os offset of where to print the font char
  100.                  in the character 'box'. (eg 0 for system font)
  101. &30    r_cbpc        DSA: Number of bytes per cached character.
  102.             VDU: y os offset of where to print the font char
  103.                  in the character 'box'. (eg char height-1 for
  104.                  system font as VDU5 plots char downwards).
  105. &34    r_linesp    Line spacing in pixels.
  106. &38    r_data        Address of data (rectangle of characters) to print
  107.             on the screen (format below).
  108. &3C    r_scrollx    Horizontal scroll offset in rectangle of characters
  109.             given in r_data of top left of redraw rectangle.
  110.             This is in pixels from the lhs of the characters.
  111.             Thus it equals n*r_charw+m where n is the number of
  112.             characters in and m is the number of pixels into
  113.             the n'th character.
  114. &40    r_scrolly    Vertical scroll offset in rectangle of characters
  115.             given in r_data of top left of redraw rectangle.
  116.             This is in pixels from the top of the characters.
  117.             Note that in single height mode each line is
  118.             r_charh+r_linesp pixels high and in double height
  119.             mode each line is 2*(r_charh+r_linesp) pixels high.
  120. &44    r_palette    Address of palette to be used for colour translation.
  121.             (see below).
  122. &48    r_for        Foreground colour to use at the start of a line as an
  123.             offset in the palette table.
  124. &4C    r_bac        Background colour to use at the start of a line as
  125.             an offset in the palette table.
  126. &50    r_workarea    Pointer to an area of workspace for the SWI to use.
  127.             The size of this workspace depends on the SWI.
  128.             (It must be word aligned).
  129. &54    r_magx        Log base 2 of number of x os co-ords per pixel.
  130. &58    r_magy      Log base 2 of number of y os co-ords per pixel.
  131. &5C    r_xsize        Width of screen in pixels.
  132. &60    r_ysize        Height of screen in pixels.
  133. &64    r_mode        Current screen mode.
  134.  
  135. Character cache format (r_caddr):
  136. ---------------------------------
  137.  
  138. When using VDU redraw, this should point to the name of the font to use, or
  139. be zero for the system font.
  140.  
  141. When using direct screen access, the module will expect this block to contain
  142. the bitmaps for all the characters it is asked to print. Each character has
  143. size r_cbpc so it will expect to find the bitmap for ascii character 'n' at
  144. address char_start=(!r_caddr)+n*r_cbpc. The character definition then
  145. consists of r_charh rows of r_cbpl each so r_cbpc=r_charh*r_cbpl. NB r_cbpl
  146. need not be a multiple of 4 so this address need not be word aligned.
  147.  
  148. The format of a row is the same of that for a sprite file except there is
  149. never any lhs wastage. Ie, the first pixel is aligned to the start of the
  150. first word. Each character is r_charw pixels wide and thus requires
  151. N=r_charw<<r_bpp bits of storage. There are special cases when N is small:
  152.  
  153.  If 0<N=<8  then r_cbpl=1 and the top 8-N bits of each byte are wasted.
  154.  If 8<N=<16 then r_cbpl=2 and the top 16-N bits of each byte are wasted.
  155.  If N>16    then r_cbpl is aligned to the next multiple of 4 bytes greater
  156.   or equal to N. (eg 16<N=<32 => r_cbpl=4, 32<N=<64 => r_cbpl=8 etc).
  157.   
  158. The SWI ZapRedraw_CachedCharSize will calculate the values of r_cbpl and
  159. r_cbpc for you from a given size of character.
  160.  
  161. Only TWO colours can be used in the defn of the character. Set all foreground
  162. pixels to 1's and background pixels to 0's. Eg, in a 16 colour mode pixels
  163. will be either 1111 or 0000. Unused bits at the end of the words (or bytes)
  164. are ignored and so can contain rubbish. The real foreground and background
  165. colours are masked in at run time.
  166.  
  167.  Examples:
  168.  
  169.  For 8*8 characters at 1 bit per pixel we have 1 byte per row. Eg "E" may be
  170.  cached as:
  171.                   b0 .. b7
  172.       row0    &7E        01111110
  173.     row1    &06        01100000
  174.       row2    &06        01100000
  175.       row3    &7E        01111110
  176.       row4    &06        01100000
  177.       row5    &06        01100000
  178.       row6    &7E        01111110
  179.       row7    &00        00000000
  180.  
  181.  If it was in a 16 colour mode then there would be one word per row and the
  182.  first rows would be:
  183.                  b0 ......................... b31
  184.      row0    &01111110    00001111111111111111111111110000
  185.      row1    &00000110    00001111111100000000000000000000
  186.      ...
  187.       
  188.  In general you have:
  189.  
  190.      Word 0                    Word (N/4)-1
  191.      b0 .... b31    ...................      b0 ..... b31
  192.      pix0 pix1 ......................pix(r_charw-1) 00000
  193.      
  194. In practice you first cache the font at one bit per pixel (eg use
  195. ZapRedraw_ReadSystemChars) and then convert it to 'n' bits per pixel (for the
  196. current mode) by use of ZapRedraw_ConvertBitmap.
  197.  
  198. Although I have said that the foreground colour must be all 1's and the
  199. background all 0's this is not strictly true. The data poked into the screen
  200. memory is (foreground mask AND bitmap) OR (background mask BIC bitmap). Thus
  201. if you have a foreground mask of &FFFFFFFF and a background mask of 0 then
  202. the bitmap will be poked directly into the screen so can have any format you
  203. like (though character merging and several other features may not work
  204. properly). This idea can be used in conjunction with ZapRedraw_CacheFontChars
  205. to create a fast redraw mode for anti aliased fonts (as used in Zap).
  206.  
  207. Format of text to display (r_data):
  208. -----------------------------------
  209.  
  210. This block contains the text to be printed on the screen. There should be
  211. sufficient text here to redraw the specified area of the screen (given its
  212. size, the scroll offset, character sizes etc). Terminating each line with
  213. the bytes 0,2 will ensure the redraw doesn't run out of text horizontally and
  214. terminating the line list with a zero will ensure the same vertically. The
  215. value in r_data points to a list of words. The n'th word in the list is the
  216. offset (from the block data start) of the n'th line of text to be printed in
  217. the window. This list can be terminated by a 0 offset in which case all
  218. further lines will be cleared to background colour (r_bac).
  219.  
  220. The data for each line consists of a string of bytes giving the characters to
  221. print. By character number 'n' will I mean the n'th (n starting from 0)
  222. bitmap in your character cache in DSA mode or the character with ASCII code
  223. 'n' in VDU redraw mode. The Redraw module does not limit n to the range 0-255
  224. but also allows higher values. Currently you can access 0-65535. Of course,
  225. ASCII characters for the codes 0-31 and 256-65535 are not defined. Zap treats
  226. these specially - see below.
  227.  
  228. The byte 0 in the data for a line introduces a control code. Bytes 1-255 just
  229. print characters n=1-255 as normal so you will need to use control codes to
  230. access characters > 256. The currently defined control sequences are:
  231.  
  232.  0,0        Prints character n=0.
  233.  0,1,f,b    Switch colour to foreground f and background b. (f/b are
  234.         palette offsets - see r_for/r_bac).
  235.  0,2        End of line - the rest of the line is cleared to the current
  236.          background colour.
  237.  0,3,l,h    Print character n=l+h*256.
  238.  0,4,f,b,x,y    Merges the characters x,y. If a pixel is clear in the bitmap
  239.         for y then the pixel is drawn according to the bitmap for x
  240.         and the current for/background colours. If the pixel is
  241.         set for y then the colours f/b are used instead for the x
  242.         pixel. Useful for laying a cursor on top of the character.
  243.         This effect is simulated in VDU mode by using sprites and
  244.         masks. This leaves the current foreground and background
  245.         colours unaltered. NB x and y may contain control codes as
  246.         well. Eg you could have x=0,0 and y=0,3,0,1. If you nest,
  247.         0,4 codes (ie either x or y contain 0,4) then only the most
  248.         deeply nested one will have effect.
  249.  0,5        For internal use only. Restores the stacked values after a
  250.          0,4 call. Putting this in your input string will probably
  251.          cause a crash.
  252.  0,6,f        Change foreground colour to f.
  253.  0,7,b        Change background colour to b.
  254.  0,8,f,b,x,y    Cursor merge of characters x,y. This is similar to 0,4 but
  255.          only works for characters &7F,&100-&105. For &7F, it masks
  256.          in the block simply by changing the for/bac cols of the
  257.          current character being printed. For &100+, the square or
  258.          line is plotted over the top of the character in the
  259.          background colour b.
  260.  
  261. Note that sequences with codes 0,3,4 evaluate to one 'screen printable
  262. character', code 1 to none, and code 2 to as many as is required. Thus it is
  263. not a simple matter to calculate the start of the n'th actual printable
  264. character given a string containing control codes as above. The SWI
  265. ZapRedraw_FindCharacter does this for you.
  266.  
  267. In DSA mode character 'n' just looks up the cached character at address
  268. r_caddr+n*r_cbpc. Usually the bitmaps will correspond to the VDU list
  269. below so that character &20 will be the bitmap for a space etc.
  270.  
  271. In VDU mode character 'n' is interpreted as below:
  272.  
  273.   &00        Prints a '0' (ASCII &30)
  274.   &01-&1A    These print the letters A-Z (ie &40 is added)
  275.   &1B-&1F    Prints "[ \ ] ^ _" respectively (ie &40 is added)
  276.   &20-&7E    Usual Ascii characters printed.
  277.   &7F        This draws a filled in block (useful for a cursor)
  278.   &80-&FF    Usual Ascii characters printed.
  279.   &100        This draws the top,bottom,left edges ie '['.
  280.   &101        This draws the top,bottom edges.
  281.   &102        This draws the top,bottom,right edges ie ']'.
  282.   &103        This draws an empty square (useful for a cursor)
  283.   &104        This draws the baseline ie '_' (useful for a cursor)
  284.   &105        This draws the left edge giving a vertical bar.
  285.   &106+        Undefined action (prints an @ for debugging purposes)
  286.           (More codes may be added in future).
  287.   
  288. The characters are drawn using OS_WriteN/OS_WriteC/OS_Plot (or Font_Paint if
  289. not using the system font).
  290.  
  291. Use ZapRedraw_FindCharacter to jump over the control codes. Use
  292. ZapRedraw_PrepareDataLine to automatically generate the r_data lines from
  293. normal text with foreground and background colour masks. Use
  294. ZapRedraw_AddVduBitmaps to create the bitmaps for character codes 0-&1F,&7F
  295. and >=&100.
  296.  
  297. Format of palette data (r_palette):
  298. -----------------------------------
  299.  
  300. All colours are specified as offsets in the palette table. Thus if you set
  301. r_for to 1 then the module will look up the word at offset 4*1 in the palette
  302. table when it comes to printing a character.
  303.  
  304. DSA MODE: The palette consists of a list of words giving the colour 'mask' to
  305. use for this colour. The mask is duplicated to fill the word out. For
  306. example, in a 16 colour mode, the mask &AAAAAAAA would stand for actual
  307. screen colour 10. The table:
  308.  
  309.         &33333333
  310.         &66666666
  311.         &AAAAAAAA
  312.         &00000000
  313.         
  314. would cause 3 to be poked into the screen when in zap colour 0, 6 when in
  315. zap colour 1 etc. The masks will usually correspond to the wimp colours. The
  316. SWI ZapRedraw_CreatePalette is provided to set them up.
  317.  
  318. The actual value poked into the screen is: (Foreground mask AND bitmap) OR
  319. (Background mask BIC bitmap) where the bitmap is as specified in r_caddr.
  320.  
  321. VDU MODE: The palette consists of a list of words giving the 24 bit colour
  322. required. The word is in the form of a standard palette entry. Ie, &BBGGRRxx
  323. where &BB is the amount of blue etc. These will usually be set up by reading
  324. the wimp palette. The SWI ZapRedraw_CreatePalette will do this for you.
  325. ColourTrans calls will be used during the redraw to find the closest
  326. available GCOL colour.
  327.  
  328. *****************************************************************
  329. * SWI Definitions                        *
  330. *****************************************************************
  331.  
  332. None of the SWI's are re-entrant unless explicitly mentioned. All the SWI's
  333. corrupt R0 and flags and can produce errors.
  334.  
  335. ZapRedraw_RedrawArea (+&00)
  336. ---------------------------
  337.  
  338. This redraws a rectangle of characters on the screen.
  339.  
  340. Entry:    R1=redraw block (as described above).
  341.     All defined offsets in the redraw block are used.
  342.     
  343.     In VDU mode r_workarea must be at least 64 bytes+the amount needed
  344.      for a sprite of one character - see ZapRedraw_SpriteSize.
  345.      If using fonts then the first word of the workarea should contain
  346.      the fontsize in points.
  347.     
  348.     In DSA mode r_workarea must be at least 64+r_cbpl bytes (and a
  349.      whole number of words long).
  350.      If b2 of the r_flags word is set then you provide an extension
  351.      routine and:
  352.       R2=address of the routine
  353.       R3=private word value to pass to the routine.
  354.  
  355. Exit:    R0 and flags corrupted.
  356.  
  357. The extension routine is provided so you can trap unknown control codes and
  358. add extra functionality to the ones that exist. For example, you may wish to
  359. change font on a colour change. Zaps fast font redraw mode does this. If you
  360. provide an extension routine then on entry to it R0=reason code R12=your
  361. private word and:
  362.  
  363.  R0=0 => Starting a raster line:
  364.       R1=redraw block
  365.       R3=address of first character
  366.       R4=r_caddr+r_cbpl*row where row (0 ... r_charh-1) is the current
  367.          character row being drawn. Or, R4=0 if in line spacing.
  368.       R5=screen address of current word being written
  369.       R6=bit offset in current word being written
  370.       R7=current word being writen (bits >= R6 are clear)
  371.       R10=start foreground mask (eg &77777777)
  372.       R11=start background mask (eg &00000000)
  373.       
  374.  R0=1 => Foreground and background colours changing (control code 0,1)
  375.       Registers as above with R3=next character after the control
  376.       code and R10,R11 new foreground/background masks etc.
  377.  
  378.  R0=4 => About to merge characters (control code 0,4)
  379.       R1=redraw block
  380.       R2=character defn table to use for the mask character
  381.       R3=next character after the merge
  382.       R4=character defn table for the base character (as for R0=1)
  383.       R6=base char
  384.       R7=mask char (or these are -1 if invalid).
  385.       R8/R9=for/bac masks where mask character bits set.
  386.       R10/R11=current for/bac masks.
  387.       NB Any changes you make to these registers will be effective for
  388.       this one character only the normal values being stacked.
  389.  
  390.  R0=6 => Foreground colour changing (control code 0,6)
  391.       Registers as for R0=1.
  392.  
  393.  R0=7 => Background colour changing (control code 0,7)
  394.       Registers as for R0=1.
  395.       
  396.  R0=8 => About to cursor merge characters (control code 0,8)
  397.       Registers as for R0=4
  398.       If R7<&100 then R10/R11 will be set to R9/R8 and next char drawn
  399.       If R7>=&100 then the characters will be merged with R9
  400.       copied into R8.
  401.  
  402.  R0=2,3,5,>8     Reserved - ignore.
  403.  
  404.  Exit:  You may corrupt R0 and R12 and alter the registers mentioned
  405.       (except R1!) to new (sensible) values.
  406.       All registers are reset at the start of a new raster line.
  407.       You must not alter the redraw block itself.
  408.     You CANNOT return errors from an extension call.
  409.  
  410. ZapRedraw_GetPaletteEntry (+&01)
  411. --------------------------------
  412.  
  413. This SWI takes a colour bitmap and duplicates it to fill a word, creating
  414. a mask as needed for r_palette in DSA mode. Eg if R0=7 and R1=2 on entry then
  415. R0=&77777777 on exit.
  416.  
  417. Entry:    R0=The colour number to be poked into the screen. (0->num_of_cols-1)
  418.     R1=r_bpp (0-5)
  419.  
  420. Exit:    R0=Mask to put in palette table (with colour duplicated to fill the
  421.     word).
  422.  
  423. ZapRedraw_RedrawRaster (+&02)
  424. -----------------------------
  425.  
  426. Redraws a single raster line. Only applies to non-vdu redraw. This is a low
  427. level call used by ZapRedraw_RedrawArea and not of much use otherwise.
  428.  
  429. Entry:    R1=redraw block
  430.            Offsets used are: r_flags,r_minx,r_maxx,r_bpp,r_charw,r_charh
  431.             r_cbpl,r_cbpc,r_palette,r_workarea.
  432.     R3=address of text to use for this line starting at the first
  433.        visible character.
  434.     R4=address of character defn table with row offset added so redraw
  435.        uses first 'row' of each bitmap, or set to 0 if you want the
  436.        line to be cleared to the background colour (eg interline gap).
  437.     R5=screen address of the start of the raster line.
  438.     R6=b0-b15    = start foreground colour to use (eg r_for value)
  439.        b16-b31    = start background colour to use (eg r_bac value)
  440.     The initial words of r_workarea are set up as follows:
  441.     #0 Pixel scroll offset within the first visible char (0->charw-1)
  442.     #4 Number of pixels to do from the first character   (0->charw-1)
  443.     #8 Number of whole characters to do after the first char
  444.     #12 Number of pixels to do in the last visible char  (0->charw-1)
  445.     #16 -
  446.     #20 Address of extension sub if redraw flags bit 2 set
  447.     #24 Extension sub private word pointer redraw flags bit 2 set
  448.             
  449. Exit:    R0 and flags corrupted.
  450.  
  451. ZapRedraw_ConvertBitmap (+&03)
  452. ------------------------------
  453.  
  454. This SWI takes a character bitmap of the form of 1 bit per pixel, (the bit
  455. set for foreground/clear for background) and converts it into a bitmap for
  456. use by the RedrawArea SWI, by changing each '1' to n '1's and each '0' to
  457. n '0's where 'n' is the number of bits per pixel given. It uses the SWI
  458. ZapRedraw_ConvBitmapChar to do this.
  459.  
  460. Entry:    R1=redraw block, offsets looked at are:
  461.     r_bpp        To find the number of bits per pixel.
  462.     r_charw        Width of char in pixels
  463.     r_charh        Height of char in pixels
  464.     r_caddr        Address to write the bitmap. Memory at offsets
  465.             R2*r_cbpc to (R3+1)*r_bpc must be preserved
  466.     r_cbpl        Cache line width in bytes (as defined under
  467.             r_caddr help text)
  468.     r_cbpc        Number of bytes per cached character (as defined
  469.             under r_caddr help text)
  470.     R2=First character to be converted (eg 0)
  471.     R3=Last character to be converted (inclusive) (eg 255)
  472.     R4=Address of source bitmap of the format described under r_caddr
  473.        but with 1 bit per pixel (ie 2 colour mode format)
  474.  
  475. Exit:    r_caddr block written to.
  476.     R0 and flags corrupted.
  477.  
  478. ZapRedraw_PrepareDataLine (+&04)
  479. --------------------------------
  480.  
  481. This SWI is to help prepare the 'r_data' field of the redraw block. It takes
  482. as input the pointer to a line of text character (0-255) to be treated as
  483. ordinary characters (0 is not a control code). It also takes as input a
  484. pointer to a background mask and a foreground mask list, giving the
  485. background and foreground colours of each character separately. The output is
  486. a line of the format required by 'r_data' with control codes changing the
  487. colours and specifying the line end. Control codes in the input string can
  488. have their colour set automatically by setting R0 to the colour.
  489.  
  490. Eg: Input:
  491.  
  492.     Text input (characters): "HELLO WORLD         "
  493.     Foreground (bytes list):  11111122222222222222
  494.     Background (bytes list):  00000000000000000000
  495.     Start background 0
  496.     Start foreground 1
  497.     Input length 20
  498.         
  499.     Output: "HELLO ",0,1,2,0,"WORLD",0,2 (highest letter used = "W").
  500.     
  501. Entry:    R0=foreground colour to use for control characters (0-&1F) or
  502.        set to -1 if you do not wish ctrl chars to be specially treated.
  503.     R1=redraw block giving start foreground background colours in
  504.        r_for,r_bac - nothing else used.
  505.     R2=pointer to text input string (length in R5)
  506.     R3=pointer to foreground mask (length in R5)
  507.     R4=pointer to background mask (length in R5)
  508.     R5=length of inputs in bytes
  509.     R6=destination buffer (length must be at least 6*R5+16 to ensure
  510.        it is big enough - colour change + 0 -> 0,0 + terminator).
  511.        
  512. Exit:    R0=highest used character code used (ie &20-&FF). You may not
  513.     want to cache all font characters as usually those >= 128 are not
  514.     needed. This tells you the range you MUST cache.
  515.     R5=length of output string (including 0,2 terminator)
  516.     Only the codes 0,0 (for byte 0) 0,1 (for change colour) 0,2 (line
  517.     end) are used.
  518.  
  519. ZapRedraw_AddCursor (+&05)
  520. --------------------------
  521.  
  522. This SWI takes a line of the same format used in 'r_data', eg the output from
  523. the above SWI, and adds in the codes to place 'cursors' over some of the text
  524. by using the code 0,4 (merge characters) or the code 0,8 (merge cursors).
  525. Here, a cursor means a string of characters to be overlayed.
  526.  
  527.  Entry:    R0=destination string
  528.      R1=redraw block giving initial r_for and r_bac.
  529.      R2=offset in source string of first character to be in the cursor
  530.     R3=cursor length (length in characters of string pointed to by R4)
  531.     R4=pointer to string of cursor characters (usually &7Fs)
  532.     R5=source string (0,2 terminated)
  533.     R6=swap colour/-1 if none. If the character having the cursor placed
  534.        over it has this foreground colour then the cursor bac/foreground
  535.        cols are swapped over (eg in a selected region).
  536.     R7=b0-b7   high byte to use for cursor characters in R4 string
  537.        b8-b15  control code to use when merging ie 4 or 8.
  538.        b16-b23 foreground colour of the cursor
  539.        b24-b31 background colour of the cursor
  540.     Room should be reserved for the string to grow by 8*R3
  541.     characters. (eg 0,4,f,b,old,0,3,l,h) If the indicated offset (R2)
  542.     is off the end of the string then it will be lengthened with spaces
  543.     (&20) so you should ensure R2+9*R3 characters extra are reserved.
  544.     
  545.  Exit:    R0=end of new destination string (after 0,2 terminator)
  546.  
  547. ZapRedraw_FindCharacter (+&06)
  548. ------------------------------
  549.  
  550. This SWI takes as input a line of the format required by 'r_data' (ie
  551. containing ctrl sequences starting with 0) and a number 'n' and returns the
  552. start of the (n+1)'th printable character within this line (ie it skips over
  553. n printable characters), ignoring colour change control codes etc. Thus on
  554. exit it points to a byte 1-255 or one of the control sequences 0,0 or 0,2 or
  555. 0,3,l,h or 0,4,f,b,c1,c2 each of which define one printable character. If the
  556. offset n is off the end of the line then it will point to the 0,2 terminator.
  557. It also keeps track of the colour changes that take place. NB If n=0 then it
  558. may still be useful - as it will jump over any colour changes before the
  559. first character. If R0>R1 on exit then the character was found, otherwise
  560. there were R1-R0 characters left to skip.
  561.  
  562. Eg: Input:    "hello ",0,1,2,3,"goodbye",0,2
  563.     Output:    If n=0 then it will point to the 'h'
  564.             If n=6 then it will point to the 'g'
  565.             If n=100 then it will point to the 0 of 0,2.
  566.  
  567.  Entry:        R0=n (number of characters to skip)
  568.               (or -1 to move to the end of the string - find its len)
  569.         R1=pointer to the input string (terminated by 0,2)
  570.          R2=current foreground colour
  571.          R3=current background colour
  572.          
  573.  Exit:        R0=If the n'th character is in the string then this points
  574.              to the end of the n'th character (start in R1)
  575.             If the n'th 'character' is the terminator (0,2) then this
  576.              equals R1 (start of the terminator)
  577.             If it reached the string terminator before the n'th
  578.              character then this is R1-number of chars not skipped
  579.          R1=start of the next printable character after skipping n.
  580.             (or string terminator if reached that first).
  581.          R2-R3 updated by any colour change control codes.
  582.          Flags corrupted.
  583.             
  584. ZapRedraw_MoveBytes (+&07)
  585. --------------------------
  586.  
  587. This is a fast byte shifting SWI. Highly optimised and bytes are shifted
  588. starting at the top or bottom depending on whether the destination address is
  589. higher or lower than the start (respectively). Thus the data is always
  590. preserved.
  591.  
  592.  Entry:        R1=source address (need not be word aligned)
  593.          R2=destination address (need not be word aligned)
  594.          R3=number of bytes to move (>=0)
  595.  
  596.  Exit:        R0-R3 and flags corrupted.
  597.  
  598. ZapRedraw_CachedCharSize (+&08)
  599. -------------------------------
  600.  
  601. This SWI works out the values of r_cbpl,r_cbpc from r_charw,r_charh,r_bpp in
  602. the manner defined under the help text on r_caddr. Ie, r_cbpl is either 1,2,
  603. or a multiple of 4 and r_cbpc=r_charh*r_cbpl.
  604.  
  605.  Entry:        R0=r_bpp value
  606.          R2=r_charw value
  607.          R3=r_charh value
  608.          
  609.  Exit:        R2=number of bytes per cache line (r_cbpl)
  610.          R3=number of bytes per cached character (r_cbpc)
  611.  
  612. ZapRedraw_ConvBitmapChar (+&09)
  613. -------------------------------
  614.  
  615. This SWI is for the use of the ConvertBitmap SWI and performs the bitmap
  616. conversion for one character. It takes a bit map of the one bit per pixel
  617. format and expands it to have n=2^R7 bits per pixel by replacing each '0'
  618. with n '0's and each '1' with the mask in R6 (usually n '1's). Thus for
  619. standard conversion you should set R6 to be 2^n-1 (=2^(2^R7)-1). (NB if R7
  620. (=r_bpp) is zero then all you have to do is copy the bitmap. R7=0 is not
  621. supported by this call.
  622.  
  623.  Entry:        R1=redraw block (only r_charh is used to find the height of
  624.             the character in pixels).
  625.          R2=bytes per cache line for the source character (1,2,*4)
  626.          R3=bytes per cache line for the dest character (1,2,*4)
  627.          R4=pointer to source character bitmap
  628.          R5=address to place destination character bitmap
  629.          R6=bit mask to insert in place of 1's (only bottom 2^R7 bits)
  630.          R7=Log_2 of number of bits per pixel (1-5)
  631.  
  632.  Exit:        R4 and R5 updated to the start of the 'next' characters.
  633.          R0 and flags corrupted.
  634.  
  635. ZapRedraw_CreatePalette (+&0A)
  636. ------------------------------
  637.  
  638. This SWI is used to create the r_palette data block. If R0=1 on entry then it
  639. takes a palette consisting of a list of wimp colour numbers (one per word)
  640. and converts it to entries of the form &BBGGRRxx, a 24 bit palette entry by
  641. using the call Wimp_ReadPalette and duplicating the nibbles. If R0=2 on entry
  642. then it takes a list of entries of the form &BBGGRRxx and converts them to
  643. colour masks required for DSA redraw (see r_palette) using ColourTrans calls
  644. and ZapRedraw_GetPaletteEntry. If R0=3 on entry then it does both, converting
  645. wimp colour numbers to DSA redraw masks.
  646.  
  647.  Entry:        R0=reason code:
  648.              b0 Set to convert wimp cols to &BBGGRRxx
  649.              b1 Set to convert &bbggrrxx to DSA colour masks
  650.              b2+ reserved - set to 0
  651.          R1=redraw block. The following are used:
  652.             r_bpp      = log_2 of bits per pixel
  653.             r_workarea = pointer to 128 byte work area to load wimp
  654.                     palette into.
  655.         R2=address of source palette
  656.         R3=address for dest palette (needs 4*R4 bytes preserved)
  657.            (source may equal destination)
  658.         R4=number of palette entries (eg 16)
  659.  
  660.  Exit:        R0 and flags corrupted.
  661.  
  662. ZapRedraw_InsertChar (+&0B)
  663. ---------------------------
  664.  
  665. This inserts a single character into a string of r_data format. If R0=0 then
  666. it inserts 0,0 and if R0>=&100 then it inserts 0,3,x,y where R0=&yyxx.
  667. Otherwise it just inserts the byte as normal.
  668.  
  669.  Entry:        R0=character
  670.          R1=string address
  671.          
  672.  Exit:        R1 updated 'till after the character
  673.          R0 and flags corrupted.
  674.  
  675. ZapRedraw_ReadSystemChars (+&0C)
  676. --------------------------------
  677.  
  678. This reads the standard system characters bitmaps via OS_Word calls. It reads
  679. them in 1 bit per pixel (8 bytes per character) form suitable for
  680. ZapRedraw_ConvertBitmap to convert it to a form usable for
  681. ZapRedraw_RedrawArea. To do this, it just bit-reverses the information read
  682. by OS_Word,10. It only reads characters &20-&FF, leaving 0-&1F untouched. The
  683. bit reversing is done efficiently so this call is fairly fast.
  684.  
  685.  Entry:        R0=buffer for bitmap (size 8*256=&800=2k)
  686.          R1=redraw block. r_workarea must be a 16 byte work area.
  687.          
  688.  Exit:        R0 and flags corrupted.
  689.  
  690. ZapRedraw_ReverseBitmaps (+&0D)
  691. -------------------------------
  692.  
  693. This SWI takes a list of bytes and reverses the bits of each byte. This is
  694. useful for reversing the bitmaps (flipping about the y axis) of 8*8 pixel
  695. characters at one bit per pixel (ie r_cbpl=1 r_cbpc=8).
  696.  
  697.  Entry:        R1=source buffer
  698.          R2=destination buffer (can equal source)
  699.          R3=number of bytes (must be a multiple of 4)
  700.  
  701.  Exit:        R0 and flags corrupted.
  702.  
  703. ZapRedraw_ReadVduVars (+&0E)
  704. ----------------------------
  705.  
  706. This SWI is used to set up the Zap redraw block initially. It puts the value
  707. 0 in r_screen so the actual screen address is used when ZapRedraw_RedrawArea
  708. is called (this can change quite often) and fills in r_bpl, r_bpp, r_magx,
  709. r_magy, r_xsize, r_ysize by using the call OS_ReadVduVariables. It also fills
  710. in r_mode by using OS_Byte 135. This call should be made after any mode
  711. change. Compensation is made for double pixel modes by decreasing r_magx. A
  712. pixel in Zap means a hardware pixel rather than an emulated double pixel.
  713.  
  714.  Entry:        R1=redraw block to update
  715.             r_workarea should point to a 64 byte scratch area.
  716.  
  717.  Exit:        R0 and flags corrupted.
  718.  
  719. ZapRedraw_GetRectangle (+&0F)
  720. -----------------------------
  721.  
  722. This SWI should be used after calls to Wimp_GetRectangle. It takes the redraw
  723. rectangle block as returned by Wimp_RedrawWindow or Wimp_GetRectangle and
  724. uses it to fill in the ZapRedraw block. The scroll offsets of the update
  725. rectangle are in pixels. The y scroll offset is the amount 'down' from the
  726. work area origin (inclusive), so negating will get the 'upward' scroll
  727. offset in pixels (exclusive), and the shifting by r_magy will give the
  728. normal OS work area scroll offset (which is exclusive).
  729.  
  730.  Entry:        R0=block as returned by Wimp_RedrawWindow/Wimp_GetRectangle
  731.             ie: window handle,minx,miny,maxx,maxy,scrollx,scrolly etc
  732.          R1=Zap redraw block with r_magx,r_magy,r_xsize,r_ysize
  733.             filled in.
  734.  
  735.  Exit:        r_minx,r_miny,r_maxx,r_maxy,r_scrollx,r_scrolly have been
  736.          filled in in the redraw block pointed to by R1.
  737.          R0 and flags corrupted.
  738.  
  739. ZapRedraw_AddVduBitmaps (+&10)
  740. ------------------------------
  741.  
  742. If you look at the VDU codes, you will see that characters 0-&1F,&7F,&100+
  743. are treated specially during a VDU redraw, drawing blocks and squares. The
  744. purpose of this SWI is to create bitmaps for these extra characters from a
  745. standard bitmap of the normal characters, so you can also use these in a DSA
  746. redraw. You specify an interval of characters, and in that interval, it
  747. creates bitmaps for the following:
  748.  
  749.     &00    Creates bitmap for '0' by copying bitmap &30
  750.     &01-&1F Creates bitmap for 'AB...' by copying bitmaps &41-&5F
  751.     &7F    Creates a filled in square.
  752.     &100    Top bottom and left edge filled [
  753.     &101    Top and bottom edges
  754.     &102    Top bottom and right edge filled ]
  755.     &103    Empty square
  756.     &104    Underscore _
  757.     &105    Left edge (giving a bar)
  758.     &106+    Undefined (currently copies the @ character).
  759.     
  760. This means that the bitmaps will then be consistent with the VDU characters
  761. of these numbers. These bitmaps are also useful as cursors.
  762.  
  763.  Entry: R1=redraw block (uses r_charw and r_charh to find the char size)
  764.         r_workarea must have 64 bytes + room for a character sprite
  765.         (see ZapRedraw_SpriteSize) reserved.
  766.         R2=first extra bitmap to create (eg 0)
  767.         R3=last extra bitmap to create (inclusive eg &104)
  768.         R4=address of bitmaps in 1 bit per pixel form.
  769.            (space must be reserved for the characters to be created).
  770.  
  771.  Exit:    R0 and flags corrupted.
  772.  
  773. ZapRedraw_CacheFontChars (+&11)
  774. -------------------------------
  775.  
  776. This SWI takes an anti-aliased font and caches a range of characters as
  777. bitmaps (see r_caddr). The cacheing can be done in any colours or screen
  778. resolution. Of course only those with foreground colour all bits set and
  779. background colour all bits clear can be used directly by
  780. ZapRedraw_RedrawArea. However, by giving a foreground colour mask of -1 and a
  781. background mask of 0 any bitmap can be drawn (see r_caddr etc). An hourglass
  782. is given with the % as the current character/256 if it takes a long time.
  783.  
  784.  Entry:    R0=reason code and other registers as below.
  785.            
  786.   R0=1 => Cache font in current wimp mode (ie wimp palette used).
  787.         R1=redraw block with the following set up:
  788.         r_bpp = number of bits per pixel to cache at
  789.         r_caddr = address of cache with space reserved for the chars
  790.         r_cbpl/cbpc/r_charw/r_charh setup
  791.         r_for/r_bac = offset in r_palette of for and bac cols
  792.         r_palette = palette of colours as for VDU redraw mode
  793.                 (ie each entry of form &BBGGRRxx)
  794.         r_workarea = room for 64 bytes + single sprite
  795.                  (use ZapRedraw_SpriteSize).
  796.         r_mode = mode to cache font in (ie mode sprite defined in).
  797.       R2=pointer to font name
  798.       R3=font size to plot at (points)
  799.       R4=x os offset (from bottom left) to plot character in the box
  800.       R5=y os offset (from bottom left) to plot character in the box
  801.       R6=first character to cache (0 caches as &30 and 1-&1F have &40
  802.          added &7F is ignored).
  803.       R7=last character to cache (inclusive)
  804.  
  805.   R0=2 => Cache font in mode 0 with background 0 and foreground 1.
  806.       R1=redraw block with the following set up:
  807.           r_caddr = address of cache with space reserved for the chars
  808.           r_cbpl/cbpc/r_charw/r_charh setup
  809.           r_workarea = as for R0=1
  810.           r_magx,r_magy for mode used with reason code R0=1
  811.       R2-R7 as for reason code R0=1.
  812.       Font size is scaled up by 2^(1-r_magx) horizontally and
  813.       2^(2-r_magy) vertically so the characters are the same pixel
  814.       size as those cached with R0=1.
  815.       
  816.  Exit: R0 and flags corrupted.
  817.  
  818. ZapRedraw_SpriteSize (+&12)
  819. ---------------------------
  820.  
  821. Several SWI's (eg ZapRedraw_RedrawArea - VDU mode, ZapRedraw_CacheFontChars)
  822. need to create a sprite area the size of a single character. This call
  823. returns the size required for this sprite (+palette+mask+save area etc), and
  824. thus the amount of workarea that should be reserved. The sprite needs a save
  825. area as it appears that Font_Paint redirects output to a sprite and thus
  826. corrupts the graphics colours. This means that it takes two passes to read
  827. the size required for the sprite - the first to read the size for the sprite
  828. and the second to create the sprite (space now reserved for it) and calculate
  829. the save area required via OS_SpriteOp,62.
  830.  
  831.  Example: SYS "ZapRedraw_SpriteSize",&01,redraw_block TO size%
  832.        PROCensure_workarea(size%)
  833.        SYS "ZapRedraw_SpriteSize",&81,redraw_block TO size%
  834.        PROCensure_workarea(size%)
  835.  (NB In practice the SWI usually requires 64+size% bytes of workspace)
  836.  
  837.  Entry:    R0=reason code
  838.         b0-b6 1=return sprite size for sprite in current mode and r_bpp
  839.               2=return sprite size for a mode 0 sprite (ie assume r_bpp=0)
  840.         b7    Clear for first pass, set for second pass.
  841.      R1=redraw block with r_bpp,r_charw,r_charh setup.
  842.         On the second pass r_workarea must be at least the size returned
  843.         by the first pass.
  844.      
  845.  Exit:  On first pass : R0=size required for sprite area (no save area).
  846.      On second pass: R0=total size required for sprite + save area.
  847.  
  848. ZapRedraw_RedrawWindow (+&13)
  849. -----------------------------
  850.  
  851. This SWI performs the calls to Wimp_RedrawWindow, Wimp_GetRectangle,
  852. Zap_GetRectangle, and Zap_RedrawArea for you. It assumes that the redraw
  853. block is already setup. This call is equivalent to the basic code:
  854.     SYS "Wimp_RedrawWindow",,data% TO flag%
  855.         WHILE flag%
  856.          SYS "ZapRedraw_GetRectangle",data%,redraw%
  857.          SYS "ZapRedraw_RedrawArea",,redraw%
  858.          SYS "Wimp_GetRectangle",,data% TO flag%
  859.         ENDWHILE
  860. where redraw% is the address of the redraw block and data% the data block
  861. returned by Wimp_Poll for event 1 (redraw window request).
  862.  
  863.  Entry:    R0=Redraw block as returned by Wimp for Wimp_Poll 1 (data%)
  864.      R1=Zap redraw block with r_data containing the text to redraw. All
  865.         of the block should be setup apart from rectangle to draw
  866.         and the scroll offsets which are filled in for you.
  867.         
  868.  Exit:    R0 and flags corrupted.
  869.